/*
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "velox/functions/lib/SubscriptUtil.h"

namespace facebook::velox::functions::sparksql {

namespace {

/// Subscript operator for arrays and maps (to be mapped from usages like
/// array[0] and map['key']).
/// - does not allow negative indices for arrays (return NULL)
/// - allow out of bounds accesses for arrays (return NULL)
/// - index starts at 0 for arrays.
using SubscriptFunction = SubscriptImpl<
    /* allowNegativeIndices */ true,
    /* nullOnNegativeIndices */ true,
    /* allowOutOfBound */ true,
    /* indexStartsAtOne */ false>;

} // namespace

VELOX_DECLARE_VECTOR_FUNCTION(
    udf_subscript,
    SubscriptFunction::signatures(),
    std::make_unique<SubscriptFunction>());

} // namespace facebook::velox::functions::sparksql
